home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1999 June / Macworld (1999-06).dmg / Serious Software / OpenScript 1.5.2 Demo / ReadMe < prev    next >
Text File  |  1999-04-09  |  5KB  |  147 lines
  1.  
  2.  
  3.  
  4.  
  5.                                                         
  6.                                                                 version 1.5.2 (FAT)
  7.                                                                 ©Copyright 1998-99 Marco Bambini
  8.  
  9. What is OpenScript?
  10. OpenScript is a plugin for every HTTP server compatible with W*API 1.1 (like WebSTAR, Quid Pro Quo, AppleShare IP or WebTen).
  11. It allows you to include AppleScript, MacPerl and Frontier commands in your HTML pages. You can also write nested commands so you can use Frontier commands inside AppleScript scripts, AppleScript commands in Frontier scripts an so on, also mixing MacPerl commands. 
  12.  
  13. Installation
  14. To install OpenScript, follow these steps:
  15. 1) Quit WebSTAR.
  16. 2) Copy the file "OpenScript" (or OpenScript Demo) into the Plug-Ins folder in the same folder as WebSTAR.
  17. 3) Relaunch WebSTAR.
  18.  
  19. Once OpenScript is installed, all the files with the suffix ".script" are filtered.
  20.  
  21. How can I use it?
  22. Just write the scripts inside the <Applescript>…</Applescript> or <Usertalk>…</Usertalk> TAGs, OpenScript execute them and place the result in your HTML page.
  23.  
  24. Example:
  25. <applescript>
  26.     set pathToUse to "Macintosh HD:page.html"
  27.     set f to open for access file pathToUse
  28.     set s to read f for get eof f
  29.                 close access f
  30.     return s
  31. </applescript>
  32.  
  33. this simple script place the contents of the file"page.html" into the page you are serving.
  34.  
  35. Try to write nested TAGs in order to use the best commands of both the scripting languages  (you have to append a number at the end of the TAG to specify the execution order of the scripts).
  36.  
  37. Example (very useless):
  38. <APPLESCRIPT>return 7+<USERTALK>return 5+<APPLESCRIPT1>return 9+ <USERTALK1>2*3*<APPLESCRIPT2>return 10/2 </APPLESCRIPT2> </USERTALK1></APPLESCRIPT1></USERTALK></APPLESCRIPT>
  39.  
  40. after OpenScript has processed this script, it will put the result (51) in your HTML page.
  41.  
  42. In order to use connection oriented information, you can use the OpenScript internal TAGs as described below.
  43.  
  44. Example:
  45. <APPLESCRIPT>
  46. if "<OpenScript?ip>" = "195.120.139.130" then
  47.     return "Welcome Marco Bambini"
  48. else
  49.     return "Welcome <OpenScript?client_domain> from <OpenScript?ip>"
  50. end if
  51. </APPLESCRIPT>
  52.  
  53. if I'll come to visit this page, I'll receive a Welcome message.
  54.  
  55. OpenScript internal TAGs:
  56.  
  57. <OpenScript?path>
  58. Path argument portion of URL
  59.  
  60. <OpenScript?search>
  61. Search argument portion of URL
  62.  
  63. <OpenScript?username>
  64. Username for current authentication scheme
  65.  
  66. <OpenScript?password>
  67. Password for current authentication scheme
  68.  
  69. <OpenScript?from>
  70. "From" header field
  71.  
  72. <OpenScript?client_domain>
  73. Domain name of client
  74.  
  75. <OpenScript?server_domain>
  76. Domain name of server
  77.  
  78. <OpenScript?port>
  79. Port number server is listening on
  80.  
  81. <OpenScript?refer>
  82. "Referer" HTTP header field value 
  83.  
  84. <OpenScript?agent>
  85. "User-Agent" HTTP header field value
  86.  
  87. <OpenScript?ip>
  88. Client's IP address
  89.  
  90. <OpenScript?http_request>
  91. Entire HTTP request as received from the client
  92.  
  93. <OpenScript?mime>
  94. MIME type of requested URL as determined by server
  95.  
  96. <OpenScript?header>
  97. Preconstructed response header field for server name 
  98.  
  99. <OpenScript?server_path>
  100. Local file system path to the server's document tree
  101.  
  102. <OpenScript?file_path>
  103. Local file system name for the requested file
  104.  
  105. <OpenScript?mod>
  106. True/false if file has been modified since last client request
  107.  
  108. <OpenScript?date>
  109. If-modified-since date string from HTTP header field
  110.  
  111. <OpenScript?security>
  112. Name of security realm (if any) protecting requested file
  113.  
  114. <OpenScript?connection_id>
  115. Unique ID for this HTTP connection
  116.  
  117. <OpenScript?execution_id>
  118. Unique ID for this execution of the server
  119.  
  120. PIXO Support
  121. The PIXO ("Plug-In Cross-Over") API is a 'standardized' way for Web server plug-ins to communicate and cooperate for better performance, advanced integration, and extra Web site coolness.
  122.  
  123. The server calls each plug-in directly and the plug-in returns the results directly to the server. Since plug-ins are all loaded directly into the server, there has not been any way to combine the features of plug-ins the way CGIs could be combined. Now that there are more plug-ins than ever and they're doing more and more interesting things, it has once again become critical that plug-ins have some way of calling each other.
  124.  
  125. PIXO ("plug-in cross-over") is an API that allows plug-ins loaded into the same server to call each other just as CGIs could but without the overhead of AppleEvents or TCP/IP. Using PIXO, modern Web server plug-ins can now call upon each other's services directly, using a simple, high-performance API, and can be combined to create extremely powerful Web sites, services, and applications.
  126.  
  127. OpenScript acts as both a PIXO SOURCE and PROCESSOR, it's action name is OPENSCRIPT_PIXO.
  128.  
  129. Tips
  130. All the error messages reported by OpenScript are located inside its resource fork in resources of type TEXT, so you can customize them.
  131.  
  132. Contact information
  133. Marco Bambini
  134. Via Piave n.21
  135. 46015 Cicognara (MN)
  136. ITALY
  137. marco.bambini@kagi.com
  138.  
  139. Connect to http://www.geocities.com/SiliconValley/Network/7185/ (software section) for the latest info.
  140.  
  141. Copyright
  142. All this material is copyright 1998-99 by Marco Bambini.
  143. OpenScript is released as is without any warranty.
  144.  
  145. Special thanks to Chuck Shotton, Grant Hulbert, Eric Bickford and ClearWay Technologies.
  146.  
  147. You can create powerful dynamic pages with AppleScript, MacPerl and Frontier scripts!!